Assurance API

Version 1.9

The Production API v1.9 and new Sandbox v1.8 released to RSP community - 1 February 2022

The Sandbox was updated to v1.9 – 4 March 2022

Updated resources – 21 July 2021

Features included in this release:

Feature / Method	Description
GET /sessions/{sessionId}/diagnostics/{diagnosticId} for response for “opticalInfo”	The diagnostic test type for Optical Info now includes additional information: transmitHealth – Transmission Quality
GET /sessions/{sessionId}/diagnostics/{diagnosticId} for response for “statusOvertime”	The diagnostic test type for Connection Quality Over Time will include additional information: transmitInfoRecords - Transmission Quality over time

Version 1.8

Additional resources – 26th March 2021

Features included in this release:

Feature / Method	Description
PUT /product/{productid}/wan	This allows for the WAN service configuration to be updated by the user, identified by product ID
PUT /product/{productid}/lan/ethernetPorts/{ethernetPortIndex}	This allows for the LAN service configuration to be updated by the user, identified by product ID
PUT /products/{productid}/lan/staticIps	This allows static IP addresses associated to product to be updated by the user, identified by product ID
PUT /products/{productid}/lan/dhcpIp	This allows DHCP and IP configuration associated to product to be updated by the user, identified by product ID
PUT /products/{productid}/voice/{voiceProfileIndex}	This allows voice service details for a single Voice profile associated to product to be updated by the user, identified by product ID
PUT /products/{productid}/voice/{voiceProfileIndex}/voicePort/{voicePortIndex}	This allows voice service details for a single voice port associated to product to be updated by the user, identified by Product ID
Assurance API RAML & Workbook	Assurance RAML files & workbook have been updated to support the above mentioned changes

Version 1.7

Additional resources – 26th March 2021

Features included in this release:

Feature / Method	Description
POST /sessions	When ONT is configured in RGW mode, the session response will include: Under the Configuration: Problem Report, the Supported Test Types will include ‘wanInfo’ and ‘lanVoiceInfo’ Under the Configuration: Problem Report, the Fault Types & Restricted Fault Type will include “NGA RGW – WAN”
POST /sessions/{sessionId}/diagnostics with Body “inputDiagnosticType”: “wanInfo”	The diagnostic test type for WAN Information will include: Configuration for WAN Overall status and summary status of the WAN service
GET /sessions/{sessionId}/diagnostics/{diagnosticId} for response for “wanInfo”	The diagnostic test type for WAN Information will include: Configuration for WAN Overall status and summary status of the WAN service
POST /sessions/{sessionId}/diagnostics with body “inputDiagnosticType”: “lanVoiceInfo”	New diagnostic test type can be initiated for LAN Information when the ONT is in RGW mode (the body of the message will support the “inputDiagnosticType”: “lanVoiceInfo”).
GET /sessions/{sessionId}/diagnostics/{diagnosticId} for response for “lanVoiceInfo”	The diagnostic test type for WAN information will include: Configuration for LAN and voice Overall Status and Summary Status of the LAN and Voice ports
GET /product/{productid}/wan	This fetches a list of WAN service details associated with a remote managed service identified by Product ID
GET /products/{productid}/lan/ethernetPorts	This fetches a list of LAN service details associated with a remote managed service identified by product ID
GET /products/{productid}/lan/hosts	This fetches a list of hosts connected to associated product
GET /products/{productid}/lan/staticIps	Static IP addresses associated to product
GET /products/{productid}/lan/dhcpIp	DHCP and IP configuration associated to product
GET /products/{productid}/voice	list of voice profiles and voice port details associated to product
Assurance API RAML & Workbook	Assurance RAML files & workbook have been updated to support the above mentioned changes

Version 1.6

Feature / Method	Description
POST /sessions	When ONT is configured in RGW mode, the session response will include: Under the Configuration: Problem Report, the Supported Test Types will exclude ‘rgwBandwidth’ and include ‘wifiInfo’. Under the Configuration: Problem Report, the Fault Types & Restricted Fault Type will include “NGA RGW – LAN/WiFi”
POST /sessions/{sessionId}/diagnostics with Body “inputDiagnosticType”: “wifiInfo”	New diagnostic test type can be initiated for Wi-Fi Information when the ONT is in RGW mode (the body of the message will support the “inputDiagnosticType”: “wifiInfo”).
GET /sessions/{sessionId}/diagnostics/{diagnosticId} for response for “wifiInfo”	The Diagnostic test type for WiFi Information will include: Configuration for Wi-Fi port index 2.4GHz (1) and 5GHz ports (5) Snapshot of the currect thraffic statistics for each of the WiFi port indexes (1 & 5) Diagnostic test of the bytes, packets and errors sent during the test diagnostic interval (of 5 seconds) Status of each Wi-Fi port index (wifiPortDiagnosticStatus) Overall Status and Summary Status of the Wi-Fi service
GET /product/{productid}/wifi	This fetches the Wi-Fi configuration and includes details of the options available for configuring the Wi-Fi configuration for each Wi-Fi port index (this does not include usernames, passwords or blocked/denied MAC address filters – due to security restrictions).
PUT /product/{productid}/wifi/{wifiPortIndex}	This allows for the Wi-Fi configuration to be changed by the user. Note: Any omitted configuration will be removed.
Assurance API RAML & Workbook	Assurance RAML files & workbook have been updated to support the above mentioned changes.

Version 1.5

Internal Chorus updates.

Version 1.4

Feature / Method	Description
GET /subscriptions	This returns subscription details.
POST /subscription	Creates a new subscription.
GET /{subscriptionid}	Used to reference subscriptions to retrieve information.
PUT /{subscriptionid}	Updates an existing Subscription.
POST /{subscriptionid}/Delete	Deletes an existing Subscription.
POST /{subscriptionid}/Deactivate	Deactivates an existing Subscription.
GET / Channels {channelId}	describe the Channel on which notifications are published.
GET / Notifications	Get a list of notifications.
GET / Notifications {notificationId}	Used to reference notification to retrieve information.

Version 1.3

Internal Chorus updates.

Version 1.2

Feature / Method	Description
GET /tests	Provides details of tests when a product id is specified.
GET /tests/{test_id}	Provides details of an individual test.
GET /tests/{test_id}/images	Enables you to retrieve images associated with tests in png format.
POST /problemReports/{problemnumber}/unlink	Enables you to unlink a problem report from an event.

Version 1.1

Feature / Method	Description
GET /events/{event_id}	Provides details of your future planned, current and recent planned and unplanned events.
GET /events/{event_id}/impact	Provides details of your services impacts by planned and unplanned events.
GET /events/{event_id}/impact download	Enables you to download events in csv format.

Version 1.0

Features included in this release:

Feature / Method	Description
GET /products/{productid}	Get Product Information
POST /sessions	Create a new diagnostic session
GET /sessions	Retrieve a set of diagnostic sessions
GET /sessions/{sessionid}	Retrieve a diagnostic session
GET /sessions/{sessionid}/schedule	Retrieve schedule details based on search criteria
POST sessions/{sessionid}/reservations	Submit a Schedule Reservation Request for the Diagnostic Session.
POST /sessions/{sessionid}/faultTypes	Update the fault type for the diagnostic session
POST /sessions/{sessionid}/problemReport	Submit a problem report for the diagnostic session
PUT /sessions/{sessionid}/cancel	Cancel a diagnostic session
POST /sessions/{sessionid}/diagnostics	Create a diagnostic test run
GET /sessions/{sessionid}/diagnostics/{diagnosticidentifier}	Retrieve a diagnostic test run
GET /problemReports	Retrieve a set of problem reports
GET /problemReports/{problemnumber}	Retrieve a problem report
PUT /problemReports/{problemnumber}	Amend a problem report
POST /problemReports/{problemnumber}/close	Close a Problem Report
POST /problemReports/{problemnumber}/cancel	Cancel a Problem Report
POST /problemReports/{problemnumber}/update	Update a Problem Report